feat(coordinator): wire config-docs via a buildSrc plugin and declarative spec#3607
Open
gauravahuja wants to merge 1 commit into
Open
feat(coordinator): wire config-docs via a buildSrc plugin and declarative spec#3607gauravahuja wants to merge 1 commit into
gauravahuja wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
gauravahuja
force-pushed
the
feat/config-docs-module
branch
from
July 23, 2026 09:27
8134ef6 to
ef74d31
Compare
…tive spec
Add a reusable 'linea.config-docs' buildSrc convention plugin that creates a
'configDocs' source set (compiled against main + the config-docs engine, kept
out of the production jar) and registers checkConfigDocs / generateConfigDocs
tasks. The tasks run the engine's generic entry points against the app's
ConfigDocsSpec, whose fully-qualified name is declared in build.gradle
(configDocs { spec = ... }) - no per-app entry-point code and no
META-INF/services file.
Coordinator applies the plugin and provides CoordinatorConfigDocsSpec (roots,
section detector, output paths) in the configDocs source set. checkConfigDocs
currently reports the undocumented keys; the config classes are annotated in
the next PR. Generated artifacts are committed in a later PR.
Refs: #3567
Signed-off-by: Gaurav Ahuja <gauravahuja9@gmail.com>
gauravahuja
force-pushed
the
feat/config-docs-coordinator-wiring
branch
from
July 23, 2026 09:51
7fc9f75 to
a89318d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Wires the
config-docsengine intocoordinator:appwithout shipping tooling in the production jar, via a reusablebuildSrcconvention plugin (so Maru can adopt with almost no code).buildSrcpluginlinea.config-docs— creates aconfigDocssource set (compiled againstmain+ the config-docs engine, kept out of the jar), adds the engine dependency, and registerscheckConfigDocs/generateConfigDocstasks. The tasks run the engine's generic entry points against the app'sConfigDocsSpec.build.gradle(configDocs { spec = "…CoordinatorConfigDocsSpec" }); the plugin passes that FQCN to the generic main, which loads it. No per-app entry-point code, noMETA-INF/services.CoordinatorConfigDocsSpec(in theconfigDocssource set) — the one declarative object: config-file roots, section detector, output paths, title.Adopting in another app (e.g. Maru)
id 'linea.config-docs'+configDocs { spec = "…" }in build.gradle.ConfigDocsSpecobject listing its roots + section package prefix.Notes
checkConfigDocscurrently reports the undocumented keys — the config classes are annotated in the next PR. Not yet wired intocheck.JavaExec(runs app code against the app classpath in a forked JVM); inputs/outputs wiring for incrementality is a follow-up.Test plan
./gradlew :coordinator:app:checkConfigDocs— runs through plugin → source set → module main → spec; reports the expected undocumented keys../gradlew :coordinator:app:generateConfigDocs— writes both artifacts../gradlew :coordinator:app:spotlessCheck :coordinator:app:compileConfigDocsKotlin— passes.Note
Low Risk
Build-time Gradle wiring and a non-production source set only; no runtime coordinator behavior or security-sensitive paths change.
Overview
Introduces a reusable
linea.config-docsconvention plugin inbuildSrcso apps can adopt config-documentation checks and generation without putting tooling on the production classpath.The plugin adds a
configDocssource set (compiled againstmainplus:jvm-libs:linea:config-docs), requires aconfigDocs { spec = "…" }FQCN, and registerscheckConfigDocs/generateConfigDocsas forkedJavaExectasks that invoke the engine’s generic mains with that spec class name.coordinator:appapplies the plugin and addsCoordinatorConfigDocsSpecin theconfigDocssource set, declaring the five TOML config roots, section package prefix, and committed JSON/Markdown output paths underdocs/tech/components/.Reviewed by Cursor Bugbot for commit a89318d. Bugbot is set up for automated code reviews on this repo. Configure here.